home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Reference Guide / C-C++ Interactive Reference Guide.iso / c_ref / csource3 / 144_01 / help.hlp < prev    next >
Encoding:
Text File  |  1985-08-21  |  2.5 KB  |  56 lines
  1. **********************************************************************
  2. *                             HELP                                   *
  3. **********************************************************************
  4. *                  COPYRIGHT 1983 EUGENE H. MALLORY                  *
  5. **********************************************************************
  6.  
  7. PROGRAM: 
  8.     HELP is a menu driven utility designed to simplify 
  9.     retrieval of misc text. 
  10.  
  11. USAGE: 
  12.     HELP [name] [>fid] 
  13.  
  14. FUNCTION: 
  15.     If  a name is given, HELP locates on the current disk or the A: 
  16.     disk, a file with the name name.HLP.  If no name is given, help 
  17.     first gives a menu of the available files on the current disk and 
  18.     the A: disk with the tag .HLP.  From this menu, a file may be 
  19.     selected.
  20.  
  21.     If the file is "indexed" (See below) help then presents a menu of 
  22.     index topics.  From this menu, a topic may be selected. Help then 
  23.     presents the topic, in pages, to the screen, with a message at the 
  24.     bottom indicating if there are more data available for that topic.
  25.  
  26.     If the file is not "indexed", help just presents the whole file 
  27.     in pages.
  28.  
  29.     Within a help file, "indexed" files contain topic lines which 
  30.     begin with a ":".  In indexed files, each topic should begin with 
  31.     a : followed by a topic.  Topic lines should be short so that 
  32.     they fit in the two column menu.
  33.  
  34.     Simple indexed files are searched for the topic lines to 
  35.     construct the menu of topics.
  36.  
  37.     If an indexed file is very long, this search can be slow.  It is 
  38.     possible to create a fast indexed file by preceeding the file 
  39.     with all of the topic lines without, repeat, without the ":".  
  40.     This index must correspond exactly with the order of the ":" 
  41.     topic lines in the text.
  42.  
  43.     Non-indexed files must contain NO lines beginning with a ":".  No 
  44.     topic menu will be built and the file will just be displayed in 
  45.     pages.
  46.  
  47.     Within a topic or a non-indexed file, text is presented in pages. 
  48.     If a lines is preceded with a ";", a page break will occur.  This 
  49.     allows the text to be organized into reasonable pages.
  50.  
  51.     The ":" and the ";" are stripped from the lines when presented. 
  52.     If the text is column dependent, remember that these will be 
  53.     stripped off. There is no restriction on the characters in the 
  54.     body of text itself. Only the first character is checked for ":" 
  55.     or ";".
  56.